home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / alGetFillPoint.z / alGetFillPoint
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((3333ddddmmmm))))                                        aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alGetFillPoint, alSetFillPoint - get or set low- or high-water mark for
  10.      an audio port
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  14.  
  15.      iiiinnnntttt aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt))))
  16.  
  17.      iiiinnnntttt aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((AAAALLLLppppoooorrrrtttt ppppoooorrrrtttt,,,, ccccoooonnnnsssstttt iiiinnnntttt ffffiiiillllllllppppooooiiiinnnntttt))))
  18.  
  19. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  20.      _p_o_r_t        expects an AAAALLLLppppoooorrrrtttt structure.  This structure is the returned
  21.                  value of an aaaallllOOOOppppeeeennnnPPPPoooorrrrtttt((((3333ddddmmmm)))) call.
  22.  
  23.      _f_i_l_l_p_o_i_n_t   expects a integer value, the fillpoint, in sample frames.
  24.  
  25. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.      aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt returns the current fillpoint of a port.
  27.  
  28.      aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt sets the current fillpoint of a port.
  29.  
  30.      Used with aaaallllGGGGeeeettttFFFFDDDD((((3333ddddmmmm)))) and sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))), controlling the
  31.      fillpoint lets you block a process until the number of sample frames in
  32.      an audio port reaches a given low- or high-water mark.
  33.  
  34.      An input port will trigger the return from a sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))) call
  35.      when there are at least _f_i_l_l_p_o_i_n_t sample frames available to be read.
  36.      For input ports, use the "readfds" fd_set with sssseeeelllleeeecccctttt((((2222)))) or the POLLIN
  37.      event flag with ppppoooollllllll((((2222)))).
  38.  
  39.      An output port will trigger the return from a sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))) call
  40.      when there are more than _f_i_l_l_p_o_i_n_t empty sample frames in the port.  For
  41.      output ports, use the "writefds" fd_set with sssseeeelllleeeecccctttt((((2222)))) or the POLLOUT
  42.      event flag with ppppoooollllllll((((2222)))).
  43.  
  44.      aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt does not perform any validity checking on the fillpoint;
  45.      it is up to the application to pass in a correct value.
  46.  
  47.      The calls aaaallllRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))), aaaallllDDDDiiiissssccccaaaarrrrddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))), aaaallllZZZZeeeerrrrooooFFFFrrrraaaammmmeeeessss, and
  48.      aaaallllWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) may change the fillpoint so you should set it just
  49.      before you call sssseeeelllleeeecccctttt((((2222)))) or ppppoooollllllll((((2222)))).
  50.  
  51. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  52.      Upon successful completion aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt returns a non-negative number.
  53.      Otherwise, aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt returns -1 and sets an error number which can
  54.      be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  55.  
  56.      aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt can fail for the following reason:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((3333ddddmmmm))))                                        aaaallllGGGGeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT   _p_o_r_t is invalid or null.
  75.  
  76.      Upon successful completion aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt returns 0.  Otherwise,
  77.      aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt returns -1 and sets an error number which can be retrieved
  78.      with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  79.  
  80.      aaaallllSSSSeeeettttFFFFiiiillllllllPPPPooooiiiinnnntttt can fail for the following reasons:
  81.  
  82.      AAAALLLL____BBBBAAAADDDD____PPPPOOOORRRRTTTT   _p_o_r_t is invalid or null.
  83.  
  84. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  85.      alOpenPort(3dm), alGetFD(3dm), alGetQueueSize(3dm), alGetFillable(3dm),
  86.      alGetFilled(3dm), oserror(3C)
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.